/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.rest4j.type;

import java.util.List;

/**
 * Representation of a model field in API XML.
 *
 * @author Joseph Kapizza <joseph@rest4j.com>
 */
public interface Field {
	/**
	 * Field name.
	 */
	String getName();

	/**
	 * Field type.
	 */
	ApiType getType();

	/**
	 * Additional data inside &lt;extra> tag of the field definition.
	 * The elements of this list are object deserialized with the JAXB object factory
	 * configured by {@link com.rest4j.ApiFactory#setExtSchema(String, Class)}.
	 */
	List getExtra();
}
